home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 3 / The Arsenal Files 3.iso / pinnacle / getkey.inf < prev    next >
Text File  |  1993-01-16  |  3KB  |  117 lines
  1.  ╔═══════════════════╗
  2.  ║                   ║
  3.  ║  WHAT IS GETKEY?  ║
  4.  ║                   ║
  5.  ╚═══════════════════╝
  6.  
  7.  
  8.   The GETKEY utility is used in a batch file to present a single-line
  9.   multiple choice question.  When you don't need something as fancy as
  10.   our GO-MENU program, GETKEY is quick and easy!
  11.  
  12.  
  13.  
  14.  ╔═════════════════════╗
  15.  ║                     ║
  16.  ║  HOW TO USE GETKEY  ║
  17.  ║                     ║
  18.  ╚═════════════════════╝
  19.  
  20.  
  21.  ╒═══════════════╕
  22.  │  QUICK-START  │
  23.  ╘═══════════════╛
  24.  
  25.  
  26.   If you are already familiar with:
  27.  
  28.   ■ Text editors
  29.   ■ Batch files
  30.   ■ The IF ERRORLEVEL batch statement
  31.  
  32.   you can learn most of what you need to know by entering the following
  33.   command at the DOS prompt:
  34.  
  35.   GETKEY /?
  36.  
  37.   A more detailed explanation of GETKEY follows.
  38.  
  39.  
  40.  
  41.  ╒══════════════════╕
  42.  │  STANDARD USAGE  │
  43.  ╘══════════════════╛
  44.  
  45.  
  46.   NOTE:  For information about creating batch files, refer to the documentation
  47.   for the GO-MENU utility.
  48.  
  49.  
  50.   The basic DOS command line format for GETKEY is:
  51.  
  52.   GETKEY <prompt text> <keys>
  53.  
  54.   For example, at the DOS prompt, you could enter the command as:
  55.  
  56.   GETKEY Do you want to continue? YN
  57.  
  58.   This will display the text (all except the final YN part).  As for the
  59.   letters YN, the first character is surrounded by brackets to show that it is
  60.   the default selection (what the user will get if he presses spacebar or
  61.   Enter).
  62.  
  63.   Normally, the first character in the list of letters is the default.  You
  64.   can change this by putting the "@" character in front of the one you want to
  65.   be the default.  For example:
  66.  
  67.   GETKEY Do you want to format all your hard disks?  Y@N
  68.  
  69.   In this case, the N would be surrounded by square brackets, indicating that
  70.   it is the default (what the user gets if he presses spacebar or Enter).
  71.  
  72.   Of course, GETKEY isn't much use unless it is used in a batch file.  It sets
  73.   the DOS ERRORLEVEL according to the letter selected, so you can control the
  74.   batch file.  For example, in this example:
  75.  
  76.   GETKEY Pick your favourite vowel AEIOUY
  77.  
  78.   The ERRORLEVEL would be set to 1 if the user selected "A", 2 if the user
  79.   selected "E", and so on.
  80.  
  81.  
  82.  ╒═══════════╕
  83.  │  PAUSING  │
  84.  ╘═══════════╛
  85.  
  86.  
  87.  GETKEY can also be used to display a message where ANY key will continue.
  88.  This is a nice alternative to the usual (and unattractive) "PAUSE" command
  89.  used in batch files.  To use GETKEY for pausing, place the "@" character at
  90.  the end of the text, without any other characters.  Thus:
  91.  
  92.  GETKEY Press any key to continue... @
  93.  
  94.  
  95.  
  96.  ╔═══════════════════════╗
  97.  ║                       ║
  98.  ║  MISCELLANEOUS NOTES  ║
  99.  ║                       ║
  100.  ╚═══════════════════════╝
  101.  
  102.  
  103.   For a quick summary of the material covered above, try starting GETKEY by
  104.   typing the following command at the DOS prompt:
  105.  
  106.   GETKEY /?
  107.  
  108.   To try a sample batch file that makes use of GETKEY, enter the following
  109.   command at the DOS prompt:
  110.  
  111.   TRYGET
  112.  
  113.   To view the batch file, enter this command:
  114.  
  115.   SEE TRYGET.BAT
  116.  
  117.